<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>FileUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/commons/io/FileUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> org.apache.commons.io;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Copyright 2007 the original author or authors.</em>
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
<a name="6" href="#6">6</a>   <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="7" href="#7">7</a>   <em class="comment"> * you may not use this file except in compliance with the License.</em>
<a name="8" href="#8">8</a>   <em class="comment"> * You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
<a name="10" href="#10">10</a>  <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="comment"> *</em>
<a name="18" href="#18">18</a>  <em class="comment"> * For more infomration visit</em>
<a name="19" href="#19">19</a>  <em class="comment"> * <a href="http://architecturerules.googlecode.com/svn/docs/index.html" target="alexandria_uri">http://architecturerules.googlecode.com/svn/docs/index.html</a></em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.*;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <em>/**<em>*</em></em>
<a name="28" href="#28">28</a>  <em> * &lt;p>FileUtils utility class extracted from the Spring Framework in order to</em>
<a name="29" href="#29">29</a>  <em> * remove the dependency on Spring for this one class.  &lt;a</em>
<a name="30" href="#30">30</a>  <em> * href="<a href="http://code.google.com/p/architecturerules/issues/detail?id=2&amp;can=1" target="alexandria_uri">http://code.google.com/p/architecturerules/issues/detail?id=2&amp;can=1</a>"></em>
<a name="31" href="#31">31</a>  <em> * issue 2 (remove unneccessary dependencies)&lt;/a>&lt;/p></em>
<a name="32" href="#32">32</a>  <em> *</em>
<a name="33" href="#33">33</a>  <em> * @author &lt;a href="<a href="mailto:burton@relativity.yi.org" target="alexandria_uri">mailto:burton@relativity.yi.org</a>">Kevin A. Burton&lt;/A></em>
<a name="34" href="#34">34</a>  <em> * @author &lt;a href="<a href="mailto:sanders@apache.org" target="alexandria_uri">mailto:sanders@apache.org</a>">Scott Sanders&lt;/a></em>
<a name="35" href="#35">35</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall&lt;/a></em>
<a name="36" href="#36">36</a>  <em> * @author &lt;a href="<a href="mailto:Christoph.Reck@dlr.de" target="alexandria_uri">mailto:Christoph.Reck@dlr.de</a>">Christoph.Reck&lt;/a></em>
<a name="37" href="#37">37</a>  <em> * @author &lt;a href="<a href="mailto:peter@apache.org" target="alexandria_uri">mailto:peter@apache.org</a>">Peter Donald&lt;/a></em>
<a name="38" href="#38">38</a>  <em> * @author &lt;a href="<a href="mailto:jefft@apache.org" target="alexandria_uri">mailto:jefft@apache.org</a>">Jeff Turner&lt;/a></em>
<a name="39" href="#39">39</a>  <em> * @author Matthew Hawthorne</em>
<a name="40" href="#40">40</a>  <em> * @author &lt;a href="<a href="mailto:jeremias@apache.org" target="alexandria_uri">mailto:jeremias@apache.org</a>">Jeremias Maerki&lt;/a></em>
<a name="41" href="#41">41</a>  <em> * @author Stephen Colebourne</em>
<a name="42" href="#42">42</a>  <em> * @author Ian Springer</em>
<a name="43" href="#43">43</a>  <em> * @author Chris Eldredge</em>
<a name="44" href="#44">44</a>  <em> * @author Jim Harrington</em>
<a name="45" href="#45">45</a>  <em> * @author Niall Pemberton</em>
<a name="46" href="#46">46</a>  <em> * @author Sandy McArthur</em>
<a name="47" href="#47">47</a>  <em> */</em>
<a name="48" href="#48">48</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/commons/io/FileUtils.html">FileUtils</a> {
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
<a name="52" href="#52">52</a>  <em>     * &lt;p>The default buffer size to use.&lt;/p></em>
<a name="53" href="#53">53</a>  <em>     *</em>
<a name="54" href="#54">54</a>  <em>     * @parameter DEFAULT_BUFFER_SIZE int</em>
<a name="55" href="#55">55</a>  <em>     */</em>
<a name="56" href="#56">56</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> DEFAULT_BUFFER_SIZE = 1024 * 4;
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>      <em>/**<em>*</em></em>
<a name="60" href="#60">60</a>  <em>     * &lt;p> Reads the contents of a file into a String. There is no</em>
<a name="61" href="#61">61</a>  <em>     * readFileToString method without encoding parameter because the default</em>
<a name="62" href="#62">62</a>  <em>     * encoding can differ between platforms and therefore results in</em>
<a name="63" href="#63">63</a>  <em>     * inconsistent results. &lt;/p></em>
<a name="64" href="#64">64</a>  <em>     *</em>
<a name="65" href="#65">65</a>  <em>     * @param file the file to read</em>
<a name="66" href="#66">66</a>  <em>     * @param encoding the encoding to use, null means platform default</em>
<a name="67" href="#67">67</a>  <em>     * @return The file contents or null if read failed.</em>
<a name="68" href="#68">68</a>  <em>     * @throws IOException in case of an I/O error</em>
<a name="69" href="#69">69</a>  <em>     * @throws UnsupportedEncodingException if the encoding is not supported by</em>
<a name="70" href="#70">70</a>  <em>     * the VM</em>
<a name="71" href="#71">71</a>  <em>     */</em>
<a name="72" href="#72">72</a>      <strong>public</strong> <strong>static</strong> String readFileToString(<strong>final</strong> File file,
<a name="73" href="#73">73</a>                                            <strong>final</strong> String encoding)
<a name="74" href="#74">74</a>              throws IOException {
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>          <strong>final</strong> InputStream inputStream = <strong>new</strong> FileInputStream(file);
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>          <strong>try</strong> {
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>              <strong>return</strong> toString(inputStream, encoding);
<a name="81" href="#81">81</a>  
<a name="82" href="#82">82</a>          } <strong>finally</strong> {
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>              closeQuietly(inputStream);
<a name="85" href="#85">85</a>          }
<a name="86" href="#86">86</a>      }
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em>/**<em>*</em></em>
<a name="90" href="#90">90</a>  <em>     * &lt;p>Get the contents of an &lt;code>InputStream&lt;/code> as a String using the</em>
<a name="91" href="#91">91</a>  <em>     * specified character encoding. &lt;p> Character encoding names can be found</em>
<a name="92" href="#92">92</a>  <em>     * at &lt;a href="<a href="http://www.iana.org/assignments/character-sets" target="alexandria_uri">http://www.iana.org/assignments/character-sets</a>">IANA&lt;/a>. &lt;p></em>
<a name="93" href="#93">93</a>  <em>     * This method buffers the input internally, so there is no need to use a</em>
<a name="94" href="#94">94</a>  <em>     * &lt;code>BufferedInputStream&lt;/code>.&lt;/p></em>
<a name="95" href="#95">95</a>  <em>     *</em>
<a name="96" href="#96">96</a>  <em>     * @param input the &lt;code>InputStream&lt;/code> to read from</em>
<a name="97" href="#97">97</a>  <em>     * @param encoding the encoding to use, null means platform default</em>
<a name="98" href="#98">98</a>  <em>     * @return the requested String</em>
<a name="99" href="#99">99</a>  <em>     * @throws NullPointerException if the input is null</em>
<a name="100" href="#100">100</a> <em>     * @throws IOException if an I/O error occurs</em>
<a name="101" href="#101">101</a> <em>     */</em>
<a name="102" href="#102">102</a>     <strong>public</strong> <strong>static</strong> String toString(<strong>final</strong> InputStream input,
<a name="103" href="#103">103</a>                                   <strong>final</strong> String encoding) throws IOException {
<a name="104" href="#104">104</a> 
<a name="105" href="#105">105</a>         <strong>final</strong> StringWriter stringWriter = <strong>new</strong> StringWriter();
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>         copy(input, stringWriter, encoding);
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>         <strong>return</strong> stringWriter.toString();
<a name="110" href="#110">110</a>     }
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>     <em>/**<em>*</em></em>
<a name="114" href="#114">114</a> <em>     * &lt;p>Copy bytes from an &lt;code>InputStream&lt;/code> to chars on a</em>
<a name="115" href="#115">115</a> <em>     * &lt;code>Writer&lt;/code> using the default character encoding of the platform.</em>
<a name="116" href="#116">116</a> <em>     * &lt;p> This method buffers the input internally, so there is no need to use</em>
<a name="117" href="#117">117</a> <em>     * a &lt;code>BufferedInputStream&lt;/code>. &lt;p> This method uses {@link</em>
<a name="118" href="#118">118</a> <em>     * InputStreamReader}.&lt;/p></em>
<a name="119" href="#119">119</a> <em>     *</em>
<a name="120" href="#120">120</a> <em>     * @param input the &lt;code>InputStream&lt;/code> to read from</em>
<a name="121" href="#121">121</a> <em>     * @param output the &lt;code>Writer&lt;/code> to write to</em>
<a name="122" href="#122">122</a> <em>     * @throws NullPointerException if the input or output is null</em>
<a name="123" href="#123">123</a> <em>     * @throws IOException if an I/O error occurs</em>
<a name="124" href="#124">124</a> <em>     * @since Commons IO 1.1</em>
<a name="125" href="#125">125</a> <em>     */</em>
<a name="126" href="#126">126</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> copy(<strong>final</strong> InputStream input, <strong>final</strong> Writer output)
<a name="127" href="#127">127</a>             throws IOException {
<a name="128" href="#128">128</a> 
<a name="129" href="#129">129</a>         <strong>final</strong> InputStreamReader inputStreamReader = <strong>new</strong> InputStreamReader(
<a name="130" href="#130">130</a>                 input);
<a name="131" href="#131">131</a>         copy(inputStreamReader, output);
<a name="132" href="#132">132</a>     }
<a name="133" href="#133">133</a> 
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em>     * &lt;p>Copy bytes from an &lt;code>InputStream&lt;/code> to chars on a</em>
<a name="137" href="#137">137</a> <em>     * &lt;code>Writer&lt;/code> using the specified character encoding. &lt;p> This</em>
<a name="138" href="#138">138</a> <em>     * method buffers the inputStream internally, so there is no need to use a</em>
<a name="139" href="#139">139</a> <em>     * &lt;code>BufferedInputStream&lt;/code>. &lt;p> Character encoding names can be</em>
<a name="140" href="#140">140</a> <em>     * found at &lt;a href="<a href="http://www.iana.org/assignments/character-sets" target="alexandria_uri">http://www.iana.org/assignments/character-sets</a>">IANA&lt;/a>.</em>
<a name="141" href="#141">141</a> <em>     * &lt;p> This method uses {@link InputStreamReader}.&lt;/p></em>
<a name="142" href="#142">142</a> <em>     *</em>
<a name="143" href="#143">143</a> <em>     * @param inputStream the &lt;code>InputStream&lt;/code> to read from</em>
<a name="144" href="#144">144</a> <em>     * @param outputStream the &lt;code>Writer&lt;/code> to write to</em>
<a name="145" href="#145">145</a> <em>     * @param encoding the encoding to use, null means platform default</em>
<a name="146" href="#146">146</a> <em>     * @throws NullPointerException if the inputStream or outputStream is null</em>
<a name="147" href="#147">147</a> <em>     * @throws IOException if an I/O error occurs</em>
<a name="148" href="#148">148</a> <em>     * @since Commons IO 1.1</em>
<a name="149" href="#149">149</a> <em>     */</em>
<a name="150" href="#150">150</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> copy(<strong>final</strong> InputStream inputStream,
<a name="151" href="#151">151</a>                             <strong>final</strong> Writer outputStream, <strong>final</strong> String encoding)
<a name="152" href="#152">152</a>             throws IOException {
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>         <strong>if</strong> (encoding == <strong>null</strong>) {
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>             copy(inputStream, outputStream);
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>         } <strong>else</strong> {
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>             <strong>final</strong> InputStreamReader inputStreamReader = <strong>new</strong> InputStreamReader(
<a name="161" href="#161">161</a>                     inputStream, encoding);
<a name="162" href="#162">162</a>             copy(inputStreamReader, outputStream);
<a name="163" href="#163">163</a>         }
<a name="164" href="#164">164</a>     }
<a name="165" href="#165">165</a> 
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>     <em>/**<em>*</em></em>
<a name="168" href="#168">168</a> <em>     * &lt;p>Copy chars from a &lt;code>Reader&lt;/code> to a &lt;code>Writer&lt;/code>. &lt;p></em>
<a name="169" href="#169">169</a> <em>     * This method buffers the input internally, so there is no need to use a</em>
<a name="170" href="#170">170</a> <em>     * &lt;code>BufferedReader&lt;/code>.&lt;/p></em>
<a name="171" href="#171">171</a> <em>     *</em>
<a name="172" href="#172">172</a> <em>     * @param input the &lt;code>Reader&lt;/code> to read from</em>
<a name="173" href="#173">173</a> <em>     * @param output the &lt;code>Writer&lt;/code> to write to</em>
<a name="174" href="#174">174</a> <em>     * @return the number of characters copied</em>
<a name="175" href="#175">175</a> <em>     * @throws NullPointerException if the input or output is null</em>
<a name="176" href="#176">176</a> <em>     * @throws IOException if an I/O error occurs</em>
<a name="177" href="#177">177</a> <em>     * @since Commons IO 1.1</em>
<a name="178" href="#178">178</a> <em>     */</em>
<a name="179" href="#179">179</a>     <strong>public</strong> <strong>static</strong> <strong>int</strong> copy(<strong>final</strong> Reader input, <strong>final</strong> Writer output)
<a name="180" href="#180">180</a>             throws IOException {
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a>         <strong>final</strong> <strong>char</strong>[] buffer = <strong>new</strong> <strong>char</strong>[DEFAULT_BUFFER_SIZE];
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>         <strong>int</strong> count = 0;
<a name="185" href="#185">185</a>         <strong>int</strong> n;
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>         <strong>while</strong> (-1 != (n = input.read(buffer))) {
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>             output.write(buffer, 0, n);
<a name="190" href="#190">190</a>             count += n;
<a name="191" href="#191">191</a>         }
<a name="192" href="#192">192</a> 
<a name="193" href="#193">193</a>         <strong>return</strong> count;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>     <em>/**<em>*</em></em>
<a name="198" href="#198">198</a> <em>     * &lt;code>Copy chars from a &lt;code>Reader&lt;/code> to bytes on an</em>
<a name="199" href="#199">199</a> <em>     * &lt;code>OutputStream&lt;/code> using the default character encoding of the</em>
<a name="200" href="#200">200</a> <em>     * platform, and calling flush. &lt;p> This method buffers the input</em>
<a name="201" href="#201">201</a> <em>     * internally, so there is no need to use a &lt;code>BufferedReader&lt;/code>. &lt;p></em>
<a name="202" href="#202">202</a> <em>     * Due to the implementation of OutputStreamWriter, this method performs a</em>
<a name="203" href="#203">203</a> <em>     * flush. &lt;p> This method uses {@link OutputStreamWriter}.&lt;/code></em>
<a name="204" href="#204">204</a> <em>     *</em>
<a name="205" href="#205">205</a> <em>     * @param input the &lt;code>Reader&lt;/code> to read from</em>
<a name="206" href="#206">206</a> <em>     * @param output the &lt;code>OutputStream&lt;/code> to write to</em>
<a name="207" href="#207">207</a> <em>     * @throws NullPointerException if the input or output is null</em>
<a name="208" href="#208">208</a> <em>     * @throws IOException if an I/O error occurs</em>
<a name="209" href="#209">209</a> <em>     * @since Commons IO 1.1</em>
<a name="210" href="#210">210</a> <em>     */</em>
<a name="211" href="#211">211</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> copy(<strong>final</strong> Reader input, <strong>final</strong> OutputStream output)
<a name="212" href="#212">212</a>             throws IOException {
<a name="213" href="#213">213</a> 
<a name="214" href="#214">214</a>         <strong>final</strong> OutputStreamWriter out = <strong>new</strong> OutputStreamWriter(output);
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>         copy(input, out);
<a name="217" href="#217">217</a>         out.flush();
<a name="218" href="#218">218</a>     }
<a name="219" href="#219">219</a> 
<a name="220" href="#220">220</a> 
<a name="221" href="#221">221</a>     <em>/**<em>*</em></em>
<a name="222" href="#222">222</a> <em>     * &lt;code>Unconditionally close an &lt;code>InputStream&lt;/code>. &lt;p> Equivalent</em>
<a name="223" href="#223">223</a> <em>     * to {@link InputStream#close()}, except any exceptions will be ignored.</em>
<a name="224" href="#224">224</a> <em>     * This is typically used in finally blocks.&lt;/code></em>
<a name="225" href="#225">225</a> <em>     *</em>
<a name="226" href="#226">226</a> <em>     * @param input the InputStream to close, may be null or already closed</em>
<a name="227" href="#227">227</a> <em>     */</em>
<a name="228" href="#228">228</a>     <strong>public</strong> <strong>static</strong> <strong>void</strong> closeQuietly(<strong>final</strong> InputStream input) {
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>         <strong>try</strong> {
<a name="231" href="#231">231</a> 
<a name="232" href="#232">232</a>             <strong>if</strong> (input != <strong>null</strong>)
<a name="233" href="#233">233</a>                 input.close();
<a name="234" href="#234">234</a> 
<a name="235" href="#235">235</a>         } <strong>catch</strong> (IOException ioe) {
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>             <em class="comment">// ignore</em>
<a name="238" href="#238">238</a>         }
<a name="239" href="#239">239</a>     }
<a name="240" href="#240">240</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

